Skip to content

Create a new Scheduled Report Export

Request

Create a new scheduled job. Set a schedule for a classic Insights report to be exported from Kantata OX to download later. You will need to write a script to download the report.

Bodyapplication/jsonrequired
insights_report_exportobject
{
  "insights_report_export": {
    "title": "string",
    "description": "string",
    "external_report_object_identifier": "string",
    "recurrence": {
      "cadence": "string",
      "start_time": "2019-08-24T14:15:22Z"
    }
  }
}

Responses

Insights Report Export has been created.

Bodyapplication/json
idinteger, (int32)

The ID of a scheduled report export.

titlestring

The name of a scheduled report export.

descriptionstring

The description of a scheduled report export, if provided.

external_report_object_identifierstring

The unique identifier of the report you want to export on a schedule. Each report has one.

recurrenceobject

The schedule for when you would like the report export to repeat, defined by the cadence and start_time.

created_atstring, (date-time)

The timestamp for when an export of a report was completed.

latest_successobject

Download the most recent successfully exported report.

Response
{
  "id": 0,
  "title": "string",
  "description": "string",
  "external_report_object_identifier": "string",
  "recurrence": {
    "cadence": "string",
    "start_time": "2019-08-24T14:15:22Z"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "latest_success": {
    "url": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}